﻿/*--------------------------------------------------------------------------------
 * Adaptive Intelligence - WordNet Component/Document Object Model Library
 * Version 2.10
 * 
 * Template Collection Class
 *      Provides a custom collection for storing Template instances.
 *------------------------------------------------------------------------------*/

/*--------------------------------------------------------------------------------
 * System Imports
 *------------------------------------------------------------------------------*/
using System;
using Adaptive.Foundation;
using Adaptive.Foundation.Collections;

namespace Adaptive.WordNet
{
    /// <summary>
    /// Provides a custom collection for storing <see cref="TemplateClass"/> instances.
    /// </summary>
    public class TemplateCollectionClass : GenericCollectionBase<TemplateClass>
    {
        /*--------------------------------------------------------------------------------
         * Constructor / Dispose / Destructor Methods
         *------------------------------------------------------------------------------*/
        #region Constructor / Dispose / Destructor Methods
        /// <summary>
        /// Initializes a new instance of the class.
        /// </summary>
        /// <remarks>
        /// This is the default constructor.
        /// </remarks>
        public TemplateCollectionClass()
            : base()
        {
        }
        #endregion

        /*--------------------------------------------------------------------------------
         * Protected Methods / Event Methods
         *------------------------------------------------------------------------------*/
        #region Protected Methods / Event Methods
        /// <summary>
        /// Gets the unique key value to associate with the specifeid object instance 
        /// when stored in the collection.
        /// </summary>
        /// <param name="itemToGetKeyFor">
        /// A <see cref="TemplateClass"/> class beiong appended to the collection instance.
        /// </param>
        /// <returns>
        /// The reference key value for the instance.
        /// </returns>
        protected override string GetKeyForObject(TemplateClass itemToGetKeyFor)
        {
            if (itemToGetKeyFor != null)
                return "";
            else
                return string.Empty;
        }
        #endregion

    }
}